refactor(crds): Use built-in OpenAPI validation #5129
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jesse-c
commented
Sep 12, 2023
| @@ -25,42 +25,77 @@ import ( | |||
| "github.com/seldonio/seldon-core/apis/go/v2/mlops/scheduler" | |||
| ) | |||
|
|
|||
| //+kubebuilder:object:root=true | |||
There was a problem hiding this comment.
explain: More conventional kubebuilder annotations to have this for both structs, and to be ordered this way. This is also the same for the new lines between fields.
jesse-c
commented
Sep 12, 2023
| // Synchronous output from this pipeline, optional | ||
| Output *PipelineOutput `json:"output,omitempty"` | ||
| } | ||
|
|
||
| // +kubebuilder:validation:Enum=inner;outer;any | ||
| type JoinType string | ||
|
|
||
| const ( |
There was a problem hiding this comment.
explain: It's not ideal that it's repeated here, but this approach seems common [1].
[1] https://github.com/search?q=%2Bkubebuilder%3Avalidation%3AEnum&type=code — e.g. Grafana, Cilium, etc.
Part of a progressive change to use the CRD validation that's available via kubebuilder [1]. This has the benefits of us: - Not having to write the code for the validation, since it's generated/handled via OpenAPI - It's structurally/programatically available in the spec - Less repetition [1] https://book.kubebuilder.io/reference/markers/crd-validation.html
ukclivecox
reviewed
Sep 18, 2023
ukclivecox
approved these changes
Sep 18, 2023
jesse-c
commented
Nov 2, 2023
| RemainingItemCount: nil, | ||
| }, | ||
| Status: "Failure", | ||
| Message: fmt.Sprintf("Pipeline.mlops.seldon.io \"%s\" is invalid: [metadata.name: Invalid value: \"%s\": must be no more than 253 characters, metadata.name: Invalid value: \"%s\": a lowercase RFC 1123 subdomain must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character (e.g. 'example.com', regex used for validation is '[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*'), spec.steps: Required value]", pipelineName, pipelineName, pipelineName), |
There was a problem hiding this comment.
RafalSkolasinski
pushed a commit
that referenced
this pull request
Jan 22, 2024
* refactor(crds): Use built-in OpenAPI validation Part of a progressive change to use the CRD validation that's available via kubebuilder [1]. This has the benefits of us: - Not having to write the code for the validation, since it's generated/handled via OpenAPI - It's structurally/programatically available in the spec - Less repetition [1] https://book.kubebuilder.io/reference/markers/crd-validation.html
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of a progressive change to use the CRD validation that's available via kubebuilder [1].
This has the benefits of us:
This uses the generate
suite_test.gofor now [2].[1] https://book.kubebuilder.io/reference/markers/crd-validation.html
[2] https://book.kubebuilder.io/cronjob-tutorial/writing-tests